Skip to main content
PATCH
/
placements
Update a placement
curl --request PATCH \
  --url https://your_a2_service/placements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "is_active": false,
  "partial_safe_update_only": false,
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}
'
{
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "no": 123,
  "campaign_permission": {
    "black": [],
    "white": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "display": {
    "clktype": 1,
    "displayfmt": {
      "ext": {},
      "h": 250,
      "w": 300
    },
    "h": 250,
    "mime": [],
    "nativefmt": {
      "ext": {}
    },
    "w": 300
  },
  "ext": {
    "approval_method": "admin",
    "display": {
      "enabled": 0
    },
    "native": {
      "enabled": 0
    },
    "payout": "rates",
    "responsive": "fixed",
    "target_ecpm": 0,
    "video": {
      "enabled": 0
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": false,
  "updated_at": "2023-11-07T05:31:56Z",
  "video": {
    "clktype": 1,
    "ctype": [
      2
    ],
    "delay": 0,
    "h": 300,
    "linear": 0,
    "maxdur": 0,
    "mime": [],
    "mindur": 0,
    "playmethod": [],
    "ptype": 1,
    "skip": 0,
    "skipafter": 0,
    "skipmin": 0,
    "w": 480
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.aiderx.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for updating placement entity.

​
created_by
string<uuid>
required

The ID of the user who created the placement

​
id
string<uuid>
required

The ID of the placement

​
name
string
required

The name of the placement

​
campaign_permission
Permission · object
deprecated

Permission

​
created_at
string<date-time> | null

The date and time the entity was created.

​
description
string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

​
display
Display · object

Schema for display placement. It contains specifications for banner display formats, native formats, and other display-related properties.

​
ext
PlacementExt · object

Schema for placement default extra configuration.

​
is_active
boolean
default:false
​
partial_safe_update_only
boolean | null
default:false

Updates fields that can be modified even when the placement is in use:

  1. Name
  2. Description
  3. Target eCPM
​
updated_at
string<date-time> | null

The date and time the entity was last updated.

​
video
Video · object

Schema for video placement. It contains specifications for video placement formats, and other video-related properties.

Response

Successful Response

Schema for placement entity.

​
created_by
string<uuid>
required

The ID of the user who created the placement

​
name
string
required

The name of the placement

​
no
integer
required
​
campaign_permission
Permission · object
deprecated

Permission

​
created_at
string<date-time> | null

The date and time the entity was created.

​
description
string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

​
display
Display · object

Schema for display placement. It contains specifications for banner display formats, native formats, and other display-related properties.

​
ext
PlacementExt · object

Schema for placement default extra configuration.

​
id
string<uuid> | null
​
is_active
boolean
default:false
​
updated_at
string<date-time> | null

The date and time the entity was last updated.

​
video
Video · object

Schema for video placement. It contains specifications for video placement formats, and other video-related properties.